<?php
return [
    // 文档标题
    'title'              => env('apidoc.title', 'miAdmin-接口文档与调试'),
    // 文档描述
    'desc'               => env('apidoc.desc', 'miAdmin 接口文档'),
    // 默认请求类型
    'default_method'     => env('apidoc.default_method', 'GET'),
    // 默认作者名称
    'default_author'     => env('apidoc.default_author', '迷人'),
    // 接口调试功能
    'notDebug'           => env('apidoc.notDebug', 'false'),
    // 允许跨域访问
    'allowCrossDomain'   => false,
    // 设置可选版本
    'apps' => [
        [
            'title' => '后台管理',
            'path' => 'app\admin\controller',
            'folder' => 'admin',
            'groups' => [
                ['title' => '欢迎页', 'name' => 'adminWelcome'],
                ['title' => '个人中心', 'name' => 'adminCenter'],
                ['title' => '会员管理', 'name' => 'adminMember'],
                ['title' => '内容管理', 'name' => 'adminCms'],
                ['title' => '设置管理', 'name' => 'adminSetting'],
                ['title' => '权限管理', 'name' => 'adminAuth'],
                ['title' => '系统管理', 'name' => 'adminSystem'],
                ['title' => '登录退出', 'name' => 'adminLogin'],
            ],
            'headers' => [
                ['name' => 'AdminToken', 'type' => 'string', 'require' => true, 'desc' => 'admin_token']
            ]
            // 'controllers'=>[
            //     'app\admin\controller\BaseDemo',
            //     'app\admin\controller\CrudDemo',
            // ],
            // 'headers'=>[
            //     ['name'=>'token','type'=>'string','desc'=>'admin应用的全局请求头参数token'],
            // ],
            // 'parameters'=>[
            //     ['name'=>'abc','type'=>'string','desc'=>'admin应用的全局请求体参数abc'],
            // ],
        ],
        [
            'title' => '门户',
            'path' => 'app\index\controller',
            'folder' => 'index',
            'groups'  => [
                ['title' => '基础模块', 'name' => 'base'],
                ['title' => '示例模块', 'name' => 'demo'],
                [
                    'title' => '多级模块', 'name' => 'subMenu',
                    'children' => [
                        ['title' => '多级v1', 'name' => 'subv1',],
                        ['title' => '多级v2', 'name' => 'subv2'],
                    ]
                ],
            ],

        ],
    ],
    // 自动生成url规则
    'auto_url' => [
        // 字母规则
        'letter_rule' => "lcfirst",
        // 多级路由分隔符
        'multistage_route_separator'  => "."
    ],
    // 指定公共注释定义的文件地址
    'definitions'        => "app\common\controller\ApiDocDefinitions",
    // 缓存配置
    'cache'              => [
        // 是否开启缓存
        'enable' => false,
    ],
    // 权限认证配置
    'auth'               => [
        // 是否启用密码验证
        'enable'     => false,
        // 全局访问密码
        'password'   => "123456",
        // 密码加密盐
        'secret_key' => "apidoc#hg_code",
        // 有效期
        'expire' => 24 * 60 * 60
    ],
    // 统一的请求Header
    'headers' => [],
    // 统一的请求参数Parameters
    'parameters' => [],
    // 统一的请求响应体
    'responses' => [
        ['name' => 'code', 'type' => 'int', 'desc' => '返回码'],
        ['name' => 'msg', 'type' => 'string', 'desc' => '返回描述'],
        ['name' => 'data', 'type' => 'object', 'desc' => '返回数据', 'main' => true],
    ],
    // md文档
    'docs'              => [],

];
